Packaging

SwitchYard supports the following packaging types for deployment:

• JAR : the default packaging type for SY apps

• WAR : useful when you want to include additional libraries with your application and/or you have web application resources (e.g. JSPs, JSF, etc.).

• EAR : supports multiple application modules in a single deployment along with additional libraries.

For an example of packaging as a WAR, check out the helpdesk quickstart. Pay particular attention to the configuration of the maven-war-plugin to include the SY descriptor and exclude dependencies in the WEB-INF/lib directory which are already available in the SwitchYard runtime.

<plugin>
   <artifactId>maven-war-plugin</artifactId>
   <configuration>
     <failOnMissingWebXml>false</failOnMissingWebXml>
     <packagingExcludes>
         WEB-INF/lib/*.jar,
         WEB-INF/classes/META-INF/switchyard.xml
     </packagingExcludes>
     <webResources>
        <resource>
           <directory>target/classes/META-INF</directory>
           <targetPath>WEB-INF</targetPath>
           <includes>
             <include>switchyard.xml</include>
           </includes>
        </resource>
     </webResources>
   </configuration>
</plugin>

EAR deployments allow multiple SwitchYard applications to be included in a single deployable archive. Keep in mind that the SY applications included in an EAR are still considered separate applications from a lifecycle and visibility (both class loading and service) standpoint. For an example of deploying a SwitchYard application as an EAR, check out ear-deployment quickstart.

Available Runtimes

SwitchYard 1.0 supports deployment into JBoss Enterprise Application Platform 6.1 . All of the supported deployment mechanisms in EAP are supported, including: file-based, CLI, maven plugin, and console. See the JBoss AS deployment documentation for more information.

Overview

The SwitchYard management console is integrated with the standard JBoss AS management console and provides the following:

• A view of the applications and services deployed on the server.

• A view of various execution metrics.

• A view of the SwitchYard subsystem configuration.

SwitchYard contributes views to the standard JBoss AS management console's Runtime and Profile pages.

Metrics Views

SwitchYard Message Metrics can be accessed on the Runtime page of the AS console under Status -> Subsystems -> SwitchYard.  This page provides a view of a comprehensive set of metrics aggregated at various levels within the system.

The following types of metrics are available:

• Message count: total, success, failed

• Processing time: total, min., avg., max.

Collected metrics can be viewed at the following levels:

• System : metrics for the entire SwitchYard runtime (all deployed applications)

• Service : metrics for a composite service in an application. Additional metric details are provided for the following:

  • Gateway: metrics for each binding on the service (e.g. FTP metrics for service "ABC")

  • Operation: metrics for each operation on the service

  • Service Reference : metrics for references invoked by the service

• Reference : metrics for a composite reference in an application.  Additional metric details are provided for the following

  • Gateway : metrics for each binding on the reference (e.g. FTP metrics for reference "ABC")

  • Operation : metrics for each operation on the reference

This page also provides the user with the ability to reset metrics at various levels.

Application Views

SwitchYard contributes a page to the Runtime Operations section which provides views detailing various aspects of SwitchYard applications running on the system.  These views may be accessed on the Runtime page of the AS console by selecting Runtime Operations -> SwitchYard.  The following views are provided:

• Applications: lists all SwitchYard applications deployed on the server

• Services: lists all Services provided by the applications deployed on the server

• References: lists all service References used by applications deployed on the server

• Artifacts: lists all artifacts referenced by applications deployed on the server

Subsystem Configuration View

SwitchYard contributes an additional view to the standard JBoss AS management console's Profile page, which can be accessed by selecting the Subsystems -> SwitchYard -> Runtime Details node.  This page displays details about to the SwitchYard subsystem configured in the AS configuration profile.

This page displays the version of the SwitchYard runtime, along with a list of installed components.  Selecting a component will populate the Component Details section below, which displays:

• Name: the component name, e.g. SOAP, Camel.

• Type: the component type, e.g. soap, camel.  (The type is the suffix used within switchyard.xml identifying component specific elements, e.g. binding.soap, implementation.camel.)

• A section providing component specific details.  For most components, this section lists any configurable properties and their current settings.

MBeans

Overview

This section provides an overview of the BPEL Console. The console provides the ability to view:

• The process definitions deployed to the BPEL engine

• The process instances executing in the BPEL engine

• The execution history of a process

• The history instances query

Installation

The easiest way to install the BPEL console is to download the SwitchYard installer and then run :

ant install-bpel-console

You will then be prompted for the location of your EAP installation, and the Installer will place the necessary WAR files in EAP.HOME/standalone/deployments.  

Alternatively, you can just simply copy the switchyard-bpel-console.war folder and switchyard-bpel-console-server.war from the Tools distribution into the EAP_HOME/standalone/deployments folder. Remember that you will need to add a marker file named "switchyard-bpel-console.war.dodeploy" in the deployments folder as well to trigger the deployment.

Logging in

The BPEL console can be located using the URL: http://localhost:8080/bpel-console.

The first screen that is presented is the login screen:

The default username is admin with password admin.

The Access Control mechanism used by the admin console is configured in the $deployFolder/bpel-console/bpel-identity.sar/META-INF/jboss-service.xml. The JAAS login module is initially set to use a property file based access mechanism, but can be replaced to use any appropriate alternative implementation.

The users for the default mechanism are configured in the property file $deployFolder/bpel-console/bpel-identity.sar/bpel-users.properties. The entries in this file represent username=password.

The user roles for the default mechanism are configured in the property file $deployFolder/bpel-console/bpel-identity.sar/bpel-roles.properties. The entries in this file represent username=role. The only role of interest currently is administrator.

Deployed Process Definitions

Once logged in, the 'Manage Instances' tab shows the currently deployed BPEL processes and their versions.

Process Instances

When a process definition is selected (Open), the list of active process instances for that process definition (and version) will be displayed in the bottom panel.

Process Versions

There is only one active version at a time. If you open a process definition the active version will be chosen by default. Sometimes you need to manage instances of a retired version (i.e. to terminate running instances). In that case the button More - Change Version allows you to select a different version of that process.

Execution History

The Execution History allows you to inspect the BPAF history data associated with a process. You can specify a timespan and whether or not you'd like to see failed/terminated instances included in the chart.

The chart has various keyboard bindings to browse through the displayed execution data:

<deploy xmlns="http://www.apache.org/ode/schemas/dd/2007/03"
	xmlns:bpl="http://www.jboss.org/bpel/examples"
	xmlns:intf="http://www.jboss.org/bpel/examples/wsdl">

	<process name="bpl:HelloGoodbye">
		<active>true</active>
        <process-events generate="all"/>
		<provide partnerLink="helloGoodbyePartnerLink">
			<service name="intf:HelloGoodbyeService" port="HelloGoodbyePort"/>
		</provide>
	</process>
</deploy> 

Instance Data and Execution Path

When a process instance is selected, its details will be displayed in the Execution Details panel. The Instance Data button will also become enabled, allowing further detail about the process to be displayed. Likewise the Execution Path button opens the related instance execution graph.

The View tab shows the instance execution graph, while the Source tab below shows all activity events

History Instance Query

Once a process instance is finished, could be 'COMPLETED', 'FAILD' or 'TERMINATED', you could search it through the History Query tab window as following:

You need to choose the Process Definition and the Process Status from the list box. You could also input the correlation key, start time and end time as criteria to search the history instances. Below is the search result.

On the History Instances List, when you double click a specific row, it will pop up a window that shows all of execution events that happened during this process instance execution.

Retiring and Reactivating Process Definitions

When a process definition is initially deployed (i.e. the first version of the process), it automatically becomes the active process definition. If that BPEL process definition is subsequently change and redeployed, then the previous version is retired, and the new version becomes the active version.

The only difference between an active and retired process definition is that a retired process definition can no longer create new process instances. However if there are current process instances associated with the retired process definition version, then these will continue to execute.

On some occasions, the administrator may wish to change which version of a process definition is considered the <emphasis>active</emphasis> version. Or they may simply want to retire the currently active process definition, so that no more process instances can be created, only allowing the already running process instances to continue until completed.

To change the status of a process definition, the administrator should select the Runtime tab from the lefthand panel, and then select the Deployments option. This will show the process definitions, their versions and their current status (active or retired).

 


Overview

In BPEL component, we are using the in-memory H2 database, this page is trying to give you an example that update it to a Mysql database.

Changing database steps

<module identifier="org.switchyard.component.bpel" implClass="org.switchyard.component.bpel.deploy.BPELComponent">
      <properties>
          <bpel.db.mode>EXTERNAL</bpel.db.mode>
          <db.emb.create>false</db.emb.create>
          <bpel.db.ext.dataSource>java:jboss/datasources/BpelDS</bpel.db.ext.dataSource>
          <hibernate.dialect>org.hibernate.dialect.MySQLInnoDBDialect</hibernate.dialect>
      </properties>
  </module>